Skip to main content
GET
Retrieve a merchant instance by its `merchant_id` (merchant id, refers to a unique merchant code assigned to the merchant)

Authorizations

X-API-Key
string
header
required

Path Parameters

merchant_id
string
required

Response

Serializer for Merchant model

id
integer
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
name
string
required

The name of the business

Maximum string length: 255
tenant_id
string<uuid> | null
required
read-only

Unique identifier for the merchant in the system

is_trashed
boolean
trashed_at
string<date-time> | null
restored_at
string<date-time> | null
short_code
string | null

Unique short code indentifier used internally to identify a merchant or distributore.g. UBA-X224, GTB-3X2, KON-001, SLOT-001, WEMA-2286, etc.

Maximum string length: 10
business_email
string<email> | null

Company registration email address

Maximum string length: 254
support_email
string<email> | null

The contact email address of the business, for support if any

Maximum string length: 254
is_active
boolean

Designates if the merchant is active

tax_identification_number
string | null

Unique tax identification number issued by federal or inland revenue service

Maximum string length: 40
registration_number
string | null

Government-issued registration number with the CAC

Maximum string length: 40
address
string | null

The physical address of the business

kyc_verified
boolean

Designates if the business has been verified by the platform

user
string<uuid> | null

ID of the user